Authorizations
A valid API key generated in Topsort's UI.
Body
⚠️ Beta Access Required Contact your sales representative to gain access to this endpoint and start using it. The context information for the predictions, including which metrics to predict.
Metrics to predict, the response will include all the selected metrics.
The opaque user ID is an anonymized unique identifier that maps to the original user ID without revealing the original value. This identifier allows Topsort to correlate user activity between auctions and user interactions, independent of the user's logged-in status. For apps or sites where users might interact while logged out, we recommend generating a random identifier (UUIDv7) on the first load, storing it on local storage (cookie, local storage, etc), and letting it live for at least a year. Otherwise, if your users are always logged in for interactions, you may use a hash of your customer ID. Correct purchase attribution requires long-lived opaque user IDs consistent between auction and event requests.
"71303ce0-de89-496d-8270-6434589615e8"
The type of object that is being reported on the interaction.
listings
, banners
The device the user is on.
desktop
, mobile
"mobile"
Response
The prediction results. This will provide a numerical value for each combination of metric/product requested on the API call.